.\" Copyright (c) 2011 Kai Wang
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $Id: dwarf_expr_current_offset.3 3962 2022-03-12 15:56:10Z jkoshy $
.\"
.Dd September 13, 2011
.Dt DWARF_EXPR_CURRENT_OFFSET 3
.Os
.Sh NAME
.Nm dwarf_expr_current_offset
.Nd retrieve the number of bytes in a location expression stream
.Sh LIBRARY
.Lb libdwarf
.Sh SYNOPSIS
.In libdwarf.h
.Ft "Dwarf_Unsigned"
.Fo dwarf_expr_current_offset
.Fa "Dwarf_P_Expr expr"
.Fa "Dwarf_Error *err"
.Fc
.Sh DESCRIPTION
Function
.Fn dwarf_expr_current_offset
returns the size in bytes of the stream representation of a location
expression.
.Pp
Argument
.Fa expr
should reference a location expression descriptor allocated using
.Xr dwarf_new_expr 3 .
.Pp
If argument
.Fa err
is not
.Dv NULL ,
it will be used to store error information in case of an error.
.Sh RETURN VALUES
On success, function
.Fn dwarf_expr_current_offset
returns the size in bytes of the location descriptor's stream
representation.
In case of an error, function
.Fn dwarf_expr_current_offset
returns
.Dv DW_DLV_NOCOUNT
and sets the argument
.Fa err .
.Sh ERRORS
Function
.Fn dwarf_expr_current_offset
can fail with:
.Bl -tag -width ".Bq Er DW_DLE_ARGUMENT"
.It Bq Er DW_DLE_ARGUMENT
Argument
.Fa expr
was
.Dv NULL .
.El
.Sh SEE ALSO
.Xr dwarf 3 ,
.Xr dwarf_add_expr_addr 3 ,
.Xr dwarf_add_expr_addr_b 3 ,
.Xr dwarf_add_expr_gen 3 ,
.Xr dwarf_expr_into_block 3 ,
.Xr dwarf_new_expr 3
